home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / X11 / XCopyArea.z / XCopyArea
Encoding:
Text File  |  1998-10-30  |  8.3 KB  |  199 lines
  1.  
  2.  
  3.  
  4.      XXXXCCCCooooppppyyyyAAAArrrreeeeaaaa((((3333XXXX11111111))))    XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))     XXXXCCCCooooppppyyyyAAAArrrreeeeaaaa((((3333XXXX11111111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XCopyArea, XCopyPlane - copy areas
  10.  
  11.      SSSSYYYYNNNNTTTTAAAAXXXX
  12.           XCopyArea(_d_i_s_p_l_a_y, _s_r_c, _d_e_s_t, _g_c, _s_r_c__x, _s_r_c__y, _w_i_d_t_h,
  13.           _h_e_i_g_h_t,  _d_e_s_t__x, _d_e_s_t__y)
  14.                 Display *_d_i_s_p_l_a_y;
  15.                 Drawable _s_r_c, _d_e_s_t;
  16.                 GC _g_c;
  17.                 int _s_r_c__x, _s_r_c__y;
  18.                 unsigned int _w_i_d_t_h, _h_e_i_g_h_t;
  19.                 int _d_e_s_t__x, _d_e_s_t__y;
  20.  
  21.           XCopyPlane(_d_i_s_p_l_a_y, _s_r_c, _d_e_s_t, _g_c, _s_r_c__x, _s_r_c__y, _w_i_d_t_h,
  22.           _h_e_i_g_h_t, _d_e_s_t__x, _d_e_s_t__y, _p_l_a_n_e)
  23.                 Display *_d_i_s_p_l_a_y;
  24.                 Drawable _s_r_c, _d_e_s_t;
  25.                 GC _g_c;
  26.                 int _s_r_c__x, _s_r_c__y;
  27.                 unsigned int _w_i_d_t_h, _h_e_i_g_h_t;
  28.                 int _d_e_s_t__x, _d_e_s_t__y;
  29.                 unsigned long _p_l_a_n_e;
  30.  
  31.      AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  32.           _d_e_s_t__x
  33.           _d_e_s_t__y    Specify the x and y coordinates, which are
  34.                     relative to the origin of the destination
  35.                     rectangle and specify its upper-left corner.
  36.  
  37.           _d_i_s_p_l_a_y   Specifies the connection to the X server.
  38.  
  39.           _g_c        Specifies the GC.
  40.  
  41.           _p_l_a_n_e     Specifies the bit plane.  You must set exactly one
  42.                     bit to 1.
  43.  
  44.           _s_r_c
  45.           _d_e_s_t      Specify the source and destination rectangles to
  46.                     be combined.
  47.  
  48.           _s_r_c__x
  49.           _s_r_c__y     Specify the x and y coordinates, which are
  50.                     relative to the origin of the source rectangle and
  51.                     specify its upper-left corner.
  52.  
  53.           _w_i_d_t_h
  54.           _h_e_i_g_h_t    Specify the width and height, which are the
  55.                     dimensions of both the source and destination
  56.                     rectangles.
  57.  
  58.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  59.           The _X_C_o_p_y_A_r_e_a function combines the specified rectangle of
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXCCCCooooppppyyyyAAAArrrreeeeaaaa((((3333XXXX11111111))))    XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))     XXXXCCCCooooppppyyyyAAAArrrreeeeaaaa((((3333XXXX11111111))))
  71.  
  72.  
  73.  
  74.           src with the specified rectangle of dest.  The drawables
  75.           must have the same root and depth, or a _B_a_d_M_a_t_c_h error
  76.           results.
  77.  
  78.           If regions of the source rectangle are obscured and have not
  79.           been retained in backing store or if regions outside the
  80.           boundaries of the source drawable are specified, those
  81.           regions are not copied. Instead, the following occurs on all
  82.           corresponding destination regions that are either visible or
  83.           are retained in backing store. If the destination is a
  84.           window with a background other than _N_o_n_e, corresponding
  85.           regions of the destination are tiled with that background
  86.           (with plane-mask of all ones and _G_X_c_o_p_y function).
  87.           Regardless of tiling or whether the destination is a window
  88.           or a pixmap, if graphics-exposures is _T_r_u_e, then
  89.           _G_r_a_p_h_i_c_s_E_x_p_o_s_e events for all corresponding destination
  90.           regions are generated.  If graphics-exposures is _T_r_u_e but no
  91.           _G_r_a_p_h_i_c_s_E_x_p_o_s_e events are generated, a _N_o_E_x_p_o_s_e event is
  92.           generated.  Note that by default graphics-exposures is _T_r_u_e
  93.           in new GCs.
  94.  
  95.           This function uses these GC components: function, plane-
  96.           mask, subwindow-mode, graphics-exposures, clip-x-origin,
  97.           clip-y-origin, and clip-mask.
  98.  
  99.           _X_C_o_p_y_A_r_e_a can generate _B_a_d_D_r_a_w_a_b_l_e, _B_a_d_G_C, and _B_a_d_M_a_t_c_h
  100.           errors.
  101.  
  102.           The _X_C_o_p_y_P_l_a_n_e function uses a single bit plane of the
  103.           specified source rectangle combined with the specified GC to
  104.           modify the specified rectangle of dest.  The drawables must
  105.           have the same root but need not have the same depth.  If the
  106.           drawables do not have the same root, a _B_a_d_M_a_t_c_h error
  107.           results.  If plane does not have exactly one bit set to 1
  108.           and the value of plane is not less than %2 sup n%, where _n
  109.           is the depth of src, a _B_a_d_V_a_l_u_e error results.
  110.  
  111.           Effectively, _X_C_o_p_y_P_l_a_n_e forms a pixmap of the same depth as
  112.           the rectangle of dest and with a size specified by the
  113.           source region. It uses the foreground/background pixels in
  114.           the GC (foreground everywhere the bit plane in src contains
  115.           a bit set to 1, background everywhere the bit plane in src
  116.           contains a bit set to 0) and the equivalent of a _C_o_p_y_A_r_e_a
  117.           protocol request is performed with all the same exposure
  118.           semantics.  This can also be thought of as using the
  119.           specified region of the source bit plane as a stipple with a
  120.           fill-style of _F_i_l_l_O_p_a_q_u_e_S_t_i_p_p_l_e_d for filling a rectangular
  121.           area of the destination.
  122.  
  123.           This function uses these GC components: function, plane-
  124.           mask, foreground, background, subwindow-mode, graphics-
  125.           exposures, clip-x-origin, clip-y-origin, and clip-mask.
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXCCCCooooppppyyyyAAAArrrreeeeaaaa((((3333XXXX11111111))))    XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))     XXXXCCCCooooppppyyyyAAAArrrreeeeaaaa((((3333XXXX11111111))))
  137.  
  138.  
  139.  
  140.           _X_C_o_p_y_P_l_a_n_e can generate _B_a_d_D_r_a_w_a_b_l_e, _B_a_d_G_C, _B_a_d_M_a_t_c_h, and
  141.           _B_a_d_V_a_l_u_e errors.
  142.  
  143.      DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  144.           _B_a_d_D_r_a_w_a_b_l_e
  145.                     A value for a Drawable argument does not name a
  146.                     defined Window or Pixmap.
  147.  
  148.           _B_a_d_G_C     A value for a GContext argument does not name a
  149.                     defined GContext.
  150.  
  151.           _B_a_d_M_a_t_c_h  An _I_n_p_u_t_O_n_l_y window is used as a Drawable.
  152.  
  153.           _B_a_d_M_a_t_c_h  Some argument or pair of arguments has the correct
  154.                     type and range but fails to match in some other
  155.                     way required by the request.
  156.  
  157.           _B_a_d_V_a_l_u_e  Some numeric value falls outside the range of
  158.                     values accepted by the request.  Unless a specific
  159.                     range is specified for an argument, the full range
  160.                     defined by the argument's type is accepted.  Any
  161.                     argument defined as a set of alternatives can
  162.                     generate this error.
  163.  
  164.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  165.           XClearArea(3X11)
  166.           _X_l_i_b - _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 4/30/98)
  196.  
  197.  
  198.  
  199.